Skip to main content

Composite QR code creation

This page will go through the creation of all the available Automatic Pix QR codes

Composite QR code

This endpoint is used in journey 2 to create a QR code containing the recurring payment contract

Request

POST 'https://apisandbox.delbank.com.br/baas/api/v1/qrcode/recurrent/'

Headers

NameDescription                            
x-delbank-api-keyRequired. API key

Body

{
"formatResponse": 2,
"cityName": "Sao Paulo",
"idRecorrencia": "RR3214567820250407ABC123XYZ89",
"frequencyType": 1,
"startDate": "2025-04-10",
"startDate": "2026-04-10",
"amount": "150.00",
"beneficiary": {
"ispb": 87654321,
"document": 12345678000199,
"name": "Empresa Recebedora LTDA"
},
"debtor": {
"type": 0,
"document": 62383288000188,
"name": "João da Silva"
},
"contractNumber": "CONTRATO-20250407-01",
"description": "Serviço mensal de assinatura",
"retries": 1,
"correlationId": "conciliacaoPixAuto123456789012345"
}

Response

The status code 200 indicates success in the transaction

Being succeeded, the return will have the following fields in Json format:

{
"idDocumento": "01000000-7337-ce0d-87ae-08dd9249fd05",
"imagemQRCodeInBase64": "iVBORw0KGgoAAAANSUhEUgAAAVQAAAFUAQAAAABT6fkYAAAFPUlEQVR4nO2bQXLjQAhFuQH3vyU3YPq/T8vOZio7sYgnFcvykyu4afiAJvrXj4o/9o/dx0ZERp2n87IrdXWe8+f1eYrMNrKGTf+UgIxzVVVklU5VgiXIGlZ//zl5LAvhx75joQ50HZ8DsollTerYcqw6B+cNrD0vsjay+sJZBPvIueicimZ1OpaxPSfOiuj7P46vKxLj7OY//Oxt1t7838ePffw2S1xrvnqcvhxJODwmN9Z/xcm32eMwx80xUj7EvhRP3Eu9ZmHWsETo480NWNqi2o28U3Cdm9jCdYh7jXHydiUUWaUrdXH0GlahA+fhZGtBzkEontTsTK3IGhbHEEA4IbiQC/MaG4HLb2H9JiY5/80KKLHEZJioXMPKv3UycRGWIZM1Qi45ydxYsoBNO7P8u9pCA9PSIKZd2zawRJH4bMgkEvIB16dmD+9gKwh+iKHGSiH2ndmYX/z7bLYFchExkEjtEC5kQsv1nQUsFmkFYnaiY53Umz6AUkQKdAs75+UkxDg7kQKJ5b5O19WeC1ifdwbHhrLAcP5D3j++s4INnCcU4xwCXTUFm7PqVlBb2LQKkgLSIohvrsaftD1Va+caVk5O3hs5Z7exzPC7Lqf3sEmZX0g6Eku7lKY2dfy7vZUFbKKUw5qYOokAQsHaRMIkly9ixz2onYh3aP2pnUbhrWGbil9ouRxBbzqfe6vyeg1roSGnCZpWgYgrJBx7c/xrC2tNoRWQeXzz3qEO3qi6z7q9z1oQl7uY5BhlksmDk8K79rA4uCnWg4IpJp6AuLJew8qmpIYeJ2nHEiXtm8a/89DLrKU8/W1kED9K3E6H+cN3FrA6CodrelbhRKN61d0AfuUatpwA0Rrh4n8EvntYpJavPsHbLMUTKo6yz5naGZtdqoV5+gQL2NEZ+Me4DJ9A1erJTX7V/q+znJ36351hzGyaLCzCdAW2sMp6dhx6bngKfQBGYjWjhTVsuE/FP29QN2Jreirs01rE2qlJLYrM0kXKjp5zqISKJ7dsYJWeqaDxGQv8SSk1IQY9uoWlmclwjsBNFie6RLtFkR9tv4F1bVS3fG7X+x7KMGou55otbM9wvGbGFSQUSlIn9vqqAxawlEnEEI6C2VFc+emzcfP8Ava6t0W+7JupF0/eAnlz9wLWzUAHY2dEmvAY5PHBJ/atYGlbeeYpc8L9CnwnudnDb29hGXM5PAdj0WaShNCgaMp6tNEGdu6VIByPiKcnX14bR8CnN/g+2zWTDVWoOcLN8y7WZaTyGhbz6EtQQk1/jWVBjc6tKmtYd6vIfgnvrptvVHICf2a3G9iaapo7fZh48GIkaU+C6TUslT3fvkfK7r7SYnM73lObNaybrKTAGJFEFLF6njnp0wt6n+XPt0C2ziRAu6cZvo8qntp/AdvelG5SEKEp/R2w3fnG/bewMwd1IdK+nS48+8pwByDz+R7eZwnGlBtXbSp0MKLD9dst+TWssb7jpOkSl7ejs0re3LKBjRi3dtcNP48nKIalR+xhLYR1GHZxp/F+RBwD0lzD1m2i9IwKsIb9WrNpH220ge3ZjGkFGjGjRguNZnbw6KgFrOfJNQOvrJypBz7FG9/a/n2W7E3mVpbJ6V5F9l2Z/tROG1hK/wZg3Dx9eV3EQnjr9hrWShN972rPiSWtPcsN+qc2XcDSnCKjjN6kFxi+9aeY1Hz1Vlawntn6Ijs/t0z4JsEpUTex8hWhFkGMmGlZZU3q2cS6UiKKuLHJPT9c+ZnN7GGDgEeYy/n/ME7e7mAVc/Pcw/728cf+sevYf9YBpg0XyvTXAAAAAElFTkSuQmCC",
"payloadJws": "eyJhbGciOiJQUzUxMiIsImtpZCI6IjJCQ0E4N0NCQUQyMDYwOEVGRDFCQzlCODA5QTU4RjExMEUxNUYyRTgiLCJ4NXQiOiJLOHFIeTYwZ1lJNzlHOG00Q2FXUEVRNFY4dWciLCJqa3UiOiJodHRwczovL3BpeC1oLmRlbGJhbmsuY29tLmJyL3YyL2p3a3MiLCJ0eXAiOiJKV1QifQ.eyJjYWxlbmRhcmlvIjp7ImV4cGlyYWNhbyI6ODY0MDAsImNyaWFjYW8iOiIyMDI1LTA1LTEzVDE4OjE0OjIzLjE3NFoiLCJhcHJlc2VudGFjYW8iOiIyMDI1LTA1LTEzVDE4OjE0OjIzLjE3NFoifSwidmFsb3IiOnsib3JpZ2luYWwiOiIxMDAwLjAxIiwibW9kYWxpZGFkZUFsdGVyYWNhbyI6MH0sInJldmlzYW8iOjEsImRldmVkb3IiOnsiY25waiI6IjQzNTg3OTgwMDAxMDciLCJub21lIjoiQ2ljbGFubyBkZSBUYWwifSwiY2hhdmUiOiIwNTg3NjkzMjU4MiIsInR4aWQiOiJ2Y2hhcmdlNTAyNmI1MmIwM2YwNDk2ZTlhMWQ3NjEwZSIsInNvbGljaXRhY2FvUGFnYWRvciI6IlBlc3F1aXNhIGRlIHNhdGlzZmHDp8OjbyIsImluZm9BZGljaW9uYWlzIjpbeyJub21lIjoiRGV0YWxoZXMgZG8gUGFnYW1lbnRvIiwidmFsb3IiOiJJbmZvcm1hw6fDo28gQWRpY2lvbmFsIGRvIFBTUCBkbyBSZWNlYmVkb3IifV0sInN0YXR1cyI6IkFUSVZBIn0.dpBOamofQSKwfHTFQNxCCcAG2UPaFu4EQkoNXjcUqV7BkhvLiC9TwbPFzCw-r6qhTHouO-F4tAh_xzmH3gC-1rR1RQ_zALoLQ8-CgnhuTtoHCXEOX3wLR8jC-YTcwxWTw82RNgfUnUtZRys2zZWM4bqnWhQiMXcjTGdo__aAUHVH1zwRQM1cV1LIfWMOits-7gupdhqSmLoDAQjr0DqEgL7lXfoRaJazTbfCFCN0v0Hc_CPHLWJycn_xhqHIADqb22-9aV0T95HxEobVFemXVBeZoGeDcXJkmjdUqhrYWQnXgLxwOKKwPfJYMJ_K9Ll1f0SaMOMZ7wZHECZgvFETug",
"payloadJwsRecorrencia": "eyJhbGciOiJQUzUxMiIsImtpZCI6IjJCQ0E4N0NCQUQyMDYwOEVGRDFCQzlCODA5QTU4RjExMEUxNUYyRTgiLCJ4NXQiOiJLOHFIeTYwZ1lJNzlHOG00Q2FXUEVRNFY4dWciLCJqa3UiOiJodHRwczovL3BpeC1oLmRlbGJhbmsuY29tLmJyL3YyL2p3a3MiLCJ0eXAiOiJKV1QifQ.eyJpZFJlYyI6IlJSMDQzNTg3OTgyMDI0MDYwNW5qdWE3c2hmNDBvIiwidmluY3VsbyI6eyJvYmpldG8iOiJDb250YSBkZSBlbmVyZ2lhIiwiZGV2ZWRvciI6eyJjcGYiOiIwNDYyMzIxNzAzNSIsImNucGoiOiIiLCJub21lIjoiQ2ljbGFubyBkYSBTaWx2YSJ9LCJjb250cmF0byI6IjEyMzQ1Njc4OTBBQkMifSwiY2FsZW5kYXJpbyI6eyJkYXRhSW5pY2lhbCI6IjIwMjQtMDEtMTAiLCJkYXRhRmluYWwiOiIyMDI2LTAxLTEwIiwicGVyaW9kaWNpZGFkZSI6IkFOVUFMIn0sInZhbG9yIjp7InZhbG9yTWluaW1vUmVjZWJlZG9yIjoiMTAwMC4wMCJ9LCJyZWNlYmVkb3IiOnsiY25waiI6IjU4NzY5MzI1ODIiLCJub21lIjoiQWxpc3NvbiBPbGl2ZWlyYSBOZXZlcyAiLCJpc3BiUGFydGljaXBhbnRlIjoiMzgyMjQ4NTcifSwicG9saXRpY2FSZXRlbnRhdGl2YSI6IlBFUk1JVEVfM1JfN0QiLCJhdHVhbGl6YWNhbyI6W3sic3RhdHVzIjoiQ1JJQURBIiwiZGF0YSI6IjIwMjUtMDUtMTNUMTg6MTQ6MjMuMTc0WiJ9XX0.jR6WOfYR4nQNWGYmhTyfK9PQkd03IjT4bpRDoXy1KMX2mNhpRGISAoAnLBg5IaQ8g7dm0c27TrwLJ97O9m1GLgLzmjQxYYPWyG0bs16yXkBrUH4MhmjREUgXs3bvSPLbPlWVAHPQTSCENm0CmtODF6RIE-UVWxAlqgl8WvRCFq_2N3i2LPa4r8r1W02nIC5y2S72k_BYYbmDHKlHBzR8DDqrZiqpbE7ny6N8HetGLOZpWD7gO7bRa2XKOuAv7tq6dRPRtL6woNnCdAXRoiTR_M2av2ak7bMdJ_T5aPHnlk-7RFSVRrhRxH1z8Beb-EdUMK5602hKmeiDK_rYeK-rsw"
}

Immediate Composite QR code

Request

POST 'https://apisandbox.delbank.com.br/baas/api/v1/qrcode/recurrent/immediate-payment'

Headers

NameDescription                            
x-delbank-api-keyRequired. API key

Body

{
"formatResponse": 0,
"key": "05876932582",
"beneficiaryName": "Fulano",
"payerText": "Pesquisa de satisfação",
"cnpjPagador": "4358798000107",
"nomePagador": "Ciclano de Tal",
"cidade": "Sao Paulo",
"zipcode": "01227-200",
"originalAmount": 1000.01,
"expiresIn": "86400",
"correlationId": "{{guid}}",
"additionalData": [
{
"name": "Detalhes do Pagamento",
"value": "Informação Adicional do PSP do Recebedor"
}
],
"reusable": false,
"contractData": {
"id": "RR0435879820240605njua7shf40o",
"frequencyType": 4,
"startDate": "2024-01-10",
"endDate": "2026-01-10",
"maxAmount": 1000,
"beneficiary": {
"ispb": 4358798,
"document": 61695227000193,
"name": "Enel89849"
},
"debtor": {
"type": 0,
"document": 4623217035,
"name": "Ciclano da Silva"
},
"contractNumber": "1234567890ABC",
"description": "Conta de energia",
"retries": 1
}
}

Response

The status code 200 indicates success in the transaction

Being succeeded, the return will have the following fields in Json format:

{
"idDocumento": "01000000-7337-ce0d-87ae-08dd9249fd05",
"imagemQRCodeInBase64": "iVBORw0KGgoAAAANSUhEUgAAAVQAAAFUAQAAAABT6fkYAAAFPUlEQVR4nO2bQXLjQAhFuQH3vyU3YPq/T8vOZio7sYgnFcvykyu4afiAJvrXj4o/9o/dx0ZERp2n87IrdXWe8+f1eYrMNrKGTf+UgIxzVVVklU5VgiXIGlZ//zl5LAvhx75joQ50HZ8DsollTerYcqw6B+cNrD0vsjay+sJZBPvIueicimZ1OpaxPSfOiuj7P46vKxLj7OY//Oxt1t7838ePffw2S1xrvnqcvhxJODwmN9Z/xcm32eMwx80xUj7EvhRP3Eu9ZmHWsETo480NWNqi2o28U3Cdm9jCdYh7jXHydiUUWaUrdXH0GlahA+fhZGtBzkEontTsTK3IGhbHEEA4IbiQC/MaG4HLb2H9JiY5/80KKLHEZJioXMPKv3UycRGWIZM1Qi45ydxYsoBNO7P8u9pCA9PSIKZd2zawRJH4bMgkEvIB16dmD+9gKwh+iKHGSiH2ndmYX/z7bLYFchExkEjtEC5kQsv1nQUsFmkFYnaiY53Umz6AUkQKdAs75+UkxDg7kQKJ5b5O19WeC1ifdwbHhrLAcP5D3j++s4INnCcU4xwCXTUFm7PqVlBb2LQKkgLSIohvrsaftD1Va+caVk5O3hs5Z7exzPC7Lqf3sEmZX0g6Eku7lKY2dfy7vZUFbKKUw5qYOokAQsHaRMIkly9ixz2onYh3aP2pnUbhrWGbil9ouRxBbzqfe6vyeg1roSGnCZpWgYgrJBx7c/xrC2tNoRWQeXzz3qEO3qi6z7q9z1oQl7uY5BhlksmDk8K79rA4uCnWg4IpJp6AuLJew8qmpIYeJ2nHEiXtm8a/89DLrKU8/W1kED9K3E6H+cN3FrA6CodrelbhRKN61d0AfuUatpwA0Rrh4n8EvntYpJavPsHbLMUTKo6yz5naGZtdqoV5+gQL2NEZ+Me4DJ9A1erJTX7V/q+znJ36351hzGyaLCzCdAW2sMp6dhx6bngKfQBGYjWjhTVsuE/FP29QN2Jreirs01rE2qlJLYrM0kXKjp5zqISKJ7dsYJWeqaDxGQv8SSk1IQY9uoWlmclwjsBNFie6RLtFkR9tv4F1bVS3fG7X+x7KMGou55otbM9wvGbGFSQUSlIn9vqqAxawlEnEEI6C2VFc+emzcfP8Ava6t0W+7JupF0/eAnlz9wLWzUAHY2dEmvAY5PHBJ/atYGlbeeYpc8L9CnwnudnDb29hGXM5PAdj0WaShNCgaMp6tNEGdu6VIByPiKcnX14bR8CnN/g+2zWTDVWoOcLN8y7WZaTyGhbz6EtQQk1/jWVBjc6tKmtYd6vIfgnvrptvVHICf2a3G9iaapo7fZh48GIkaU+C6TUslT3fvkfK7r7SYnM73lObNaybrKTAGJFEFLF6njnp0wt6n+XPt0C2ziRAu6cZvo8qntp/AdvelG5SEKEp/R2w3fnG/bewMwd1IdK+nS48+8pwByDz+R7eZwnGlBtXbSp0MKLD9dst+TWssb7jpOkSl7ejs0re3LKBjRi3dtcNP48nKIalR+xhLYR1GHZxp/F+RBwD0lzD1m2i9IwKsIb9WrNpH220ge3ZjGkFGjGjRguNZnbw6KgFrOfJNQOvrJypBz7FG9/a/n2W7E3mVpbJ6V5F9l2Z/tROG1hK/wZg3Dx9eV3EQnjr9hrWShN972rPiSWtPcsN+qc2XcDSnCKjjN6kFxi+9aeY1Hz1Vlawntn6Ijs/t0z4JsEpUTex8hWhFkGMmGlZZU3q2cS6UiKKuLHJPT9c+ZnN7GGDgEeYy/n/ME7e7mAVc/Pcw/728cf+sevYf9YBpg0XyvTXAAAAAElFTkSuQmCC",
"payloadJws": "eyJhbGciOiJQUzUxMiIsImtpZCI6IjJCQ0E4N0NCQUQyMDYwOEVGRDFCQzlCODA5QTU4RjExMEUxNUYyRTgiLCJ4NXQiOiJLOHFIeTYwZ1lJNzlHOG00Q2FXUEVRNFY4dWciLCJqa3UiOiJodHRwczovL3BpeC1oLmRlbGJhbmsuY29tLmJyL3YyL2p3a3MiLCJ0eXAiOiJKV1QifQ.eyJjYWxlbmRhcmlvIjp7ImV4cGlyYWNhbyI6ODY0MDAsImNyaWFjYW8iOiIyMDI1LTA1LTEzVDE4OjE0OjIzLjE3NFoiLCJhcHJlc2VudGFjYW8iOiIyMDI1LTA1LTEzVDE4OjE0OjIzLjE3NFoifSwidmFsb3IiOnsib3JpZ2luYWwiOiIxMDAwLjAxIiwibW9kYWxpZGFkZUFsdGVyYWNhbyI6MH0sInJldmlzYW8iOjEsImRldmVkb3IiOnsiY25waiI6IjQzNTg3OTgwMDAxMDciLCJub21lIjoiQ2ljbGFubyBkZSBUYWwifSwiY2hhdmUiOiIwNTg3NjkzMjU4MiIsInR4aWQiOiJ2Y2hhcmdlNTAyNmI1MmIwM2YwNDk2ZTlhMWQ3NjEwZSIsInNvbGljaXRhY2FvUGFnYWRvciI6IlBlc3F1aXNhIGRlIHNhdGlzZmHDp8OjbyIsImluZm9BZGljaW9uYWlzIjpbeyJub21lIjoiRGV0YWxoZXMgZG8gUGFnYW1lbnRvIiwidmFsb3IiOiJJbmZvcm1hw6fDo28gQWRpY2lvbmFsIGRvIFBTUCBkbyBSZWNlYmVkb3IifV0sInN0YXR1cyI6IkFUSVZBIn0.dpBOamofQSKwfHTFQNxCCcAG2UPaFu4EQkoNXjcUqV7BkhvLiC9TwbPFzCw-r6qhTHouO-F4tAh_xzmH3gC-1rR1RQ_zALoLQ8-CgnhuTtoHCXEOX3wLR8jC-YTcwxWTw82RNgfUnUtZRys2zZWM4bqnWhQiMXcjTGdo__aAUHVH1zwRQM1cV1LIfWMOits-7gupdhqSmLoDAQjr0DqEgL7lXfoRaJazTbfCFCN0v0Hc_CPHLWJycn_xhqHIADqb22-9aV0T95HxEobVFemXVBeZoGeDcXJkmjdUqhrYWQnXgLxwOKKwPfJYMJ_K9Ll1f0SaMOMZ7wZHECZgvFETug",
"payloadJwsRecorrencia": "eyJhbGciOiJQUzUxMiIsImtpZCI6IjJCQ0E4N0NCQUQyMDYwOEVGRDFCQzlCODA5QTU4RjExMEUxNUYyRTgiLCJ4NXQiOiJLOHFIeTYwZ1lJNzlHOG00Q2FXUEVRNFY4dWciLCJqa3UiOiJodHRwczovL3BpeC1oLmRlbGJhbmsuY29tLmJyL3YyL2p3a3MiLCJ0eXAiOiJKV1QifQ.eyJpZFJlYyI6IlJSMDQzNTg3OTgyMDI0MDYwNW5qdWE3c2hmNDBvIiwidmluY3VsbyI6eyJvYmpldG8iOiJDb250YSBkZSBlbmVyZ2lhIiwiZGV2ZWRvciI6eyJjcGYiOiIwNDYyMzIxNzAzNSIsImNucGoiOiIiLCJub21lIjoiQ2ljbGFubyBkYSBTaWx2YSJ9LCJjb250cmF0byI6IjEyMzQ1Njc4OTBBQkMifSwiY2FsZW5kYXJpbyI6eyJkYXRhSW5pY2lhbCI6IjIwMjQtMDEtMTAiLCJkYXRhRmluYWwiOiIyMDI2LTAxLTEwIiwicGVyaW9kaWNpZGFkZSI6IkFOVUFMIn0sInZhbG9yIjp7InZhbG9yTWluaW1vUmVjZWJlZG9yIjoiMTAwMC4wMCJ9LCJyZWNlYmVkb3IiOnsiY25waiI6IjU4NzY5MzI1ODIiLCJub21lIjoiQWxpc3NvbiBPbGl2ZWlyYSBOZXZlcyAiLCJpc3BiUGFydGljaXBhbnRlIjoiMzgyMjQ4NTcifSwicG9saXRpY2FSZXRlbnRhdGl2YSI6IlBFUk1JVEVfM1JfN0QiLCJhdHVhbGl6YWNhbyI6W3sic3RhdHVzIjoiQ1JJQURBIiwiZGF0YSI6IjIwMjUtMDUtMTNUMTg6MTQ6MjMuMTc0WiJ9XX0.jR6WOfYR4nQNWGYmhTyfK9PQkd03IjT4bpRDoXy1KMX2mNhpRGISAoAnLBg5IaQ8g7dm0c27TrwLJ97O9m1GLgLzmjQxYYPWyG0bs16yXkBrUH4MhmjREUgXs3bvSPLbPlWVAHPQTSCENm0CmtODF6RIE-UVWxAlqgl8WvRCFq_2N3i2LPa4r8r1W02nIC5y2S72k_BYYbmDHKlHBzR8DDqrZiqpbE7ny6N8HetGLOZpWD7gO7bRa2XKOuAv7tq6dRPRtL6woNnCdAXRoiTR_M2av2ak7bMdJ_T5aPHnlk-7RFSVRrhRxH1z8Beb-EdUMK5602hKmeiDK_rYeK-rsw"
}

Static Composite QR code

Request

POST 'https://apisandbox.delbank.com.br/baas/api/v1/qrcode/recurrent/static'

Headers

NameDescription                            
x-delbank-api-keyRequired. API key

Body

{
"formatResponse": 1,
"key": "05876932582",
"amount": 1100.01,
"beneficiaryName": "Fulano de Tal",
"city": "Sao Paulo",
"zipcode": "01227-200",
"correlationId": "{{guid}}",
"additionalData": [
{
"name": "Detalhes do Pagamento",
"value": "Informação Adicional do PSP do Recebedor"
}
],
"contractData": {
"id": "RR0435879820240605njua7shf40o",
"frequencyType": 4,
"startDate": "2024-01-10",
"endDate": "2026-01-10",
"maxAmount": 550,
"beneficiary": {
"ispb": 4358798,
"document": 61695227000193,
"name": "Enel"
},
"debtor": {
"type": 0,
"document": 4623217035,
"name": "Ciclano da Silva"
},
"contractNumber": "1234567890ABC",
"description": "Conta de energia",
"retries": 1
}
}

Response

The status code 200 indicates success in the transaction

Being succeeded, the return will have the following fields in Json format:

{
"payloadBase64": "MDAwMjAxMjYzMzAwMTRici5nb3YuYmNiLnBpeDAxMTEwNTg3NjkzMjU4MjUyMDQwMDAwNTMwMzk4NjU0MDcxMTAwLjAxNTgwMkJSNTkyM0FsaXNzb24gT2xpdmVpcmEgTmV2ZXMgNjAwOVNhbyBQYXVsbzYxMDkwMTIyNy0yMDA2MjI1MDUyMXZjaGFyZ2U0YmYxMGQzNzljNTU0ZjgwNzEwMDE0YnIuZ292LmJjYi5waXgyNTQ5cGl4LWguZGVsYmFuay5jb20uYnIvdjEvcmVjL3ZjaGFyZ2U0YmYxMGQzNzljNTU0ZjYzMDQyOTFB",
"payloadJwsRecorrencia": "eyJhbGciOiJQUzUxMiIsImtpZCI6IjJCQ0E4N0NCQUQyMDYwOEVGRDFCQzlCODA5QTU4RjExMEUxNUYyRTgiLCJ4NXQiOiJLOHFIeTYwZ1lJNzlHOG00Q2FXUEVRNFY4dWciLCJqa3UiOiJodHRwczovL3BpeC1oLmRlbGJhbmsuY29tLmJyL3YyL2p3a3MiLCJ0eXAiOiJKV1QifQ.eyJpZFJlYyI6IlJSMDQzNTg3OTgyMDI0MDYwNW5qdWE3c2hmNDBvIiwidmluY3VsbyI6eyJvYmpldG8iOiJDb250YSBkZSBlbmVyZ2lhIiwiZGV2ZWRvciI6eyJjcGYiOiIwNDYyMzIxNzAzNSIsImNucGoiOiIiLCJub21lIjoiQ2ljbGFubyBkYSBTaWx2YSJ9LCJjb250cmF0byI6IjEyMzQ1Njc4OTBBQkMifSwiY2FsZW5kYXJpbyI6eyJkYXRhSW5pY2lhbCI6IjIwMjQtMDEtMTAiLCJkYXRhRmluYWwiOiIyMDI2LTAxLTEwIiwicGVyaW9kaWNpZGFkZSI6IkFOVUFMIn0sInZhbG9yIjp7InZhbG9yTWluaW1vUmVjZWJlZG9yIjoiNTUwLjAwIn0sInJlY2ViZWRvciI6eyJjbnBqIjoiNTg3NjkzMjU4MiIsIm5vbWUiOiJBbGlzc29uIE9saXZlaXJhIE5ldmVzICIsImlzcGJQYXJ0aWNpcGFudGUiOiIzODIyNDg1NyJ9LCJwb2xpdGljYVJldGVudGF0aXZhIjoiUEVSTUlURV8zUl83RCIsImF0dWFsaXphY2FvIjpbeyJzdGF0dXMiOiJDUklBREEiLCJkYXRhIjoiMjAyNS0wNS0xM1QxODoyNzowOC45OThaIn1dfQ.gNyJtYD6if9spB91AT8vY__CqtOK6Yww3umwdVjKeP4SQqHdxr1hVMj0Iz5e328cjhaQA3krPcgeXRmOaS-CZyP2tUjvZ-6dpDe6KS8rWU5TNZwnI4LB2sL0dIDxT7lVE1YJ2RtcJrc_N-npnGy7x2jX4RSHNjmGi06347ufOBOV-OW_ycw3sNosFLyFIKzVl52ewT3ro4eEPvJfCkD8WKVwpypeKjvc1dwiBWm4CTQxj9soWkxcBxKD-dAppas15Ejq1aQlPA6WSsgVliC6e5W28QAy2ydxsuRnDlquxMTPbotZyp6lSZxlX7gtDmP8WTjhjX77iyJpfQyaQWeYNg"
}

Composite QR code with Due Date

Request

POST 'https://apisandbox.delbank.com.br/baas/api/v1/qrcode/recurrent/due-date'

Headers

NameDescription                            
x-delbank-api-keyRequired. API key

Body

{
"formatResponse": 1,
"key": "05876932582",
"beneficiaryName": "Fulano de Tal",
"beneficiaryAddress": "Rua Pix, 123",
"city": "Sao Paulo",
"uf": "SP",
"zipcode": "01227-200",
"payerText": "Pesquisa de satisfação",
"payerDocument": "70180307000105",
"beneficiaryDocument": "05876932582",
"payerName": "Ciclano de Tal",
"originalAmount": 1001.16,
"rebate": 1.11,
"discount": 0.04,
"interest": 10.15,
"fine": 200.22,
"dueDate": "2021-06-17",
"maxDaysOverdue": 365,
"correlationId": "{{guid}}",
"additionalData": [
{
"nome": "Detalhes do Pagamento",
"valor": "Informação Adicional do PSP do Recebedor"
}
],
"reusable": false,
"contractData": {
"id": "RR0435879820240605njua7shf40o",
"frequencyType": 4,
"startDate": "2024-01-10",
"endDate": "2026-01-10",
"maxAmount": 1000,
"beneficiary": {
"ispb": 4358798,
"document": 61695227000193,
"name": "Enel"
},
"debtor": {
"type": 0,
"document": 4623217035,
"name": "Ciclano da Silva"
},
"contractNumber": "1234567890ABC",
"description": "Conta de energia",
"retries": 1
}
}

Response

The status code 200 indicates success in the transaction

Being succeeded, the return will have the following fields in Json format:

{
"idDocumento":"52c43361-caa1-4ddb-9152-708426ª25db3",
"imagemQRCodeInBase64":"SkQuUElYLlFSQ29kZS5EaW5hbWljbw==……",
"payloadJws":"eyJhbGciOiJQUzUxMiIsImtpZCI6Ijg1MUI5ODdBNzEwQTk3MkM0QkIxODVFRUY4ODg1RTI4MzQzRUI1MDYi...",
"payloadJwsRecorrencia":"eyJhbGciOiJQUzUxMiIsImtpZCI6IjUwQTM5Qzc0MUE0RTFDQjQxN0Y2OEM2Q0MwMkY2M0JFO..."
}

Update Composite QR code with Due Date

Request

PUT 'https://apisandbox.delbank.com.br/baas/api/v1/qrcode/recurrent/:id'

Headers

NameDescription                            
x-delbank-api-keyRequired. API key

Path Parameters:

NameTypeDescription
identifierstringRequired. Authorization identifier

Body

{
"id": "52c43361-caa1-4ddb-9152-708426a25db4",
"formatResponse": 1,
"key": "[email protected]",
"beneficiaryDocument": "11111111111",
"beneficiaryName": "Fulano de Tal",
"beneficiaryAddress": "Rua Pix, 123",
"city": "Sao Paulo",
"uf": "SP",
"zipcode": "01227-200",
"payerText": "Pesquisa de satisfação",
"payerDocument": "4358798000107",
"payerName": "Ciclano de Tal",
"originalAmount": 1001.16,
"rebate": 1.11,
"discount": 0.04,
"interest": 10.15,
"fine": 200.22,
"dueDate": "2021-06-17",
"maxDaysOverduesVenc": 365,
"correlationId": "JDPI2020010300000000000000000000001",
"additionalData": [
{
"name": "Detalhes do Pagamento",
"value": "Informação Adicional do PSP do Recebedor"
}
],
"reusable": false,
"contractData": {
"startDate": "2025-03-15",
"debtor": {
"type": 0,
"document": 4623217035,
"name": "Ciclano da Silva"
}
}
}

Response

The status code 200 indicates success in the transaction

Being succeeded, the return will have the following fields in Json format:

{
"id":"52c43361-caa1-4ddb-9152-708426ª25db3",
"payloadBase64":"SkQuUElYLlFSQ29kZS5EaW5hbWljbw==……"
"payloadJwsRecorrencia":"eyJhbGciOiJQUzUxMiIsImtpZCI6IjUwQTM5Qzc0MUE0RTFDQjQxN0Y2OEM2Q0MwMkY2M0JFO..."
}